home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / util / libs / WBStart.lha / WBStart / dev / wbstart.doc
Encoding:
Text File  |  1996-09-19  |  2.5 KB  |  89 lines
  1. TABLE OF CONTENTS
  2.  
  3. wbstart.library/WBStartTagList
  4.  
  5. wbstart.library/WBStartTagList                  wbstart.library/WBStartTagList
  6. wbstart.library/WBStartTags                         wbstart.library/WBStartTags
  7.  
  8.    NAME
  9.         WBStartTagList -- Start a program as WB program
  10.  
  11.    SYNOPSIS
  12.         success = WBStartTagList(tags)
  13.         D0                       A0
  14.  
  15.         LONG WBStartTagList(struct TagItem *)
  16.  
  17.         success = WBStartTags(tag1, ...)
  18.  
  19.         LONG WBStartTags(Tag, ...)
  20.  
  21.    FUNCTION
  22.         Start a file as WB program.
  23.  
  24.         The following tags are currently supported. All information is copied
  25.         so you can free the resources after the library call.
  26.  
  27.          WBStart_Name            (const char *)
  28.  
  29.             Name of the file to start. It may be the name of a program, a tool
  30.             or a project. If the name does not contain an absolute path name
  31.             then the file will be searched relative to WBStart_DirectoryName
  32.             or WBStart_DirectoryLock.
  33.  
  34.             This tag must be specified. Otherwise WBStartTagList() will fail.
  35.  
  36.          WBStart_DirectoryName   (const char *)
  37.  
  38.             Name of a directory where the search for WBStart_Name starts.
  39.             Mutually exclusive to WBStart_DirectoryLock.
  40.  
  41.             Default: NULL lock
  42.  
  43.          WBStart_DirectoryLock   (BPTR)
  44.  
  45.             Lock of a directory where the search for WBStart_Name starts.
  46.             Mutually exclusive to WBStart_DirectoryName.
  47.  
  48.             NOTE: If you supply a NULL lock then the name supplied with
  49.                   WBStart_Name has to contain an absolute path!
  50.  
  51.             Default: NULL lock
  52.  
  53.          WBStart_Stack           (ULONG)
  54.  
  55.             Stack size of the new process. A larger stack setting in the tool
  56.             or project icons overrides this value.
  57.  
  58.             Default: 4096 Bytes
  59.  
  60.          WBStart_Priority        (LONG)
  61.  
  62.             Priority of the new process.
  63.  
  64.             Default: 0
  65.  
  66.          WBStart_ArgumentsCount  (ULONG)
  67.  
  68.             Number of arguments in the list specified by WBStart_ArgumentList.
  69.  
  70.             Default: 0
  71.  
  72.          WBStart_ArgumentList    (struct WBArg *)
  73.  
  74.             Pointer to an array of Workbench arguments. This list will be
  75.             appended to the argument list for the tool.
  76.  
  77.             If a list is specified then WBStart_ArgumentsCount must be
  78.             specified too, otherwise WBStartTagList() will fail.
  79.  
  80.             Default: NULL, i.e. no argument list
  81.  
  82.    INPUTS
  83.         tags - list of TagItems
  84.  
  85.    RESULTS
  86.         success - RETURN_OK if the program could be started
  87.  
  88.  
  89.